-
-
Notifications
You must be signed in to change notification settings - Fork 60
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
changed SuperCell to Lattice, long overdue #550
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CodeQL found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.
My first thought is that lattice is nicer than supercell, it feels more natural 👍 Then there could also be a |
The ambiguity of referencing to the lattice/unit-cell as a supercell is confusing when we are also dealing with the description of the *number of supercells*. Therefore we have changed all SuperCell references and sc arguments to Lattice and lattice, respectively. This surely comes at a cost for end-users, since this is a major transition. I will keep backwards compatibility with the older implementations for at least a year (perhaps 2). But they should eventually be gone to prefer the lattice. Signed-off-by: Nick Papior <[email protected]>
Signed-off-by: Nick Papior <[email protected]>
Codecov Report
@@ Coverage Diff @@
## main #550 +/- ##
==========================================
+ Coverage 86.20% 86.23% +0.03%
==========================================
Files 370 370
Lines 46702 46777 +75
==========================================
+ Hits 40258 40338 +80
+ Misses 6444 6439 -5
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
I like Note that in 3D there exists only 14 different Bravais lattices. Maybe they could be introduced for some symmetry-related functionality? |
Ok, so let's merge this and be gone with the madness. @tfrederiksen once merged, it would be nice to see if hubbard works with no changes, I have tried to catch tests as much as possible, but with this major change I have the feeling that I forgot something ;) |
With inspiration from spglib, one could rename |
Hmm, I am not too fond of that convention. Kind of like |
I was considering |
I am just wondering if the notion of But I'm also fine with |
agreed, |
Isn't it rather that a supercell means the collection of the unit cell + its neighbours? |
yes, but that is essentially what |
Another word could be |
That's not entirely fitting either, is it orbital connections, or ... Hmm... in the sparse structures we use |
It is weird because So |
Supercells in plural is what I find a bit confusing terminology. |
True... The plot thickens... |
The ambiguity of referencing to the lattice/unit-cell as a supercell is confusing when we are also dealing with the description of the number of supercells.
Therefore we have changed all SuperCell references and sc arguments to Lattice and lattice, respectively.
This surely comes at a cost for end-users, since this is a major transition. I will keep backwards compatibility with the older implementations for at least a year (perhaps 2). But they should eventually be gone to prefer the lattice.
@tfrederiksen @pfebrer please chip in here, the discussion about this entered in #95. I have long wanted to change this since it is a bit ambiguous in its meaning.
This change will allow it to differ from "supercells" which I think is much clearer.
The
Lattice
name was basically chosen to continue the.cell
access of the lattice vectors.I have thought about this for some time, but if you have suggestions, please do let me know!
The initial discussion also considered:
Cell
, lattice vectorsabc
Cell
, lattice vectorscell
(a little problematic IMHO)CHANGELOG